/**
 * Copyright © 2008, EMC Corporation.
 * Redistribution and use in source and binary forms, with or without modification, 
 * are permitted provided that the following conditions are met:
 *
 *     + Redistributions of source code must retain the above copyright notice, 
 *       this list of conditions and the following disclaimer.
 *     + Redistributions in binary form must reproduce the above copyright 
 *       notice, this list of conditions and the following disclaimer in the 
 *       documentation and/or other materials provided with the distribution.
 *     + The name of EMC Corporation may not be used to endorse or promote 
 *       products derived from this software without specific prior written 
 *       permission.
 *
 *      THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 *      "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 
 *      TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 *      PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS 
 *      BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 *      CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 *      SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 *      INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *      CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 *      ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 *      POSSIBILITY OF SUCH DAMAGE.
 */
package com.emc.esu.api
{
	/**
 	 * Encapsulates a ESU object path.  Performs validation upon construction
 	 * to ensure that the path format is valid.  
 	 */
	public class ObjectPath extends Identifier {
	    /**
	     * Regular expression used to validate identifiers.
	     */
	    private static const PATH_FORMAT:RegExp = /^(\/[a-zA-Z0-9 _\\.\\+\\-]+)*/;
	    
	    /**
	     * Stores the string representation of the identifier
	     */
	    private var _path:String;
	
	    /**
	     * Constructs a new object identifier
	     * @param path the object path as a string
	     */
	    public function ObjectPath( path:String ) {
	        if( !PATH_FORMAT.test( path ) ) {
	            throw new EsuError( path + " is not a valid object path" );
	        }
	        this._path = path;
	    }
	    
	    /**
	     * Returns the path as a string
	     * @return the path as a string
	     */
	    public function toString():String {
	        return _path;
	    }
	    
	    /**
	     * Returns true if the object paths are equal.
	     */
	    public function equals( obj:Object ):Boolean {
	        if( !(obj is ObjectPath) ) {
	            return false;
	        }
	        
	        return _path == obj.toString();
	        
	    }
	    
	    /**
	     * Returns true if the object path represents
	     * a directory.
	     */
	    public function isDirectory():Boolean {
	    	return _path.charAt( _path.length-1 ) == '/';
	    }
	    
	    /**
	     * Finds the index of an ObjectId in an array
	     */
	    public static function findInArray( path:ObjectPath, arr:Array ):int {
	    	for( var i:int=0; i<arr.length; i++ ) {
	    		if( path.equals( arr[i] ) ) {
	    			return i;
	    		}
	    	}
	    	
	    	
	    	return -1;
	    }
		
		public function get path():String {
			return this._path;
		}
	}
}